TimePunch User Profile Service
Dieser Service bietet Methoden um Mitarbeiterprofile in TimePunch zu bearbeiten.
CreateNewUserProfile
Mit Hilfe diese Methode kann ein neues Mitarbeiterprofil in TimePunch erstellt werden. Dazu werden nur wenige Angaben benötigt. Als Ergebnis werden die Core Berechtigungen des Mitarbeiters zurückgeliefert.
UserProfileRightsDto CreateNewUserProfile(
out TpFault fault,
TpAuthentication authentication,
string userName,
Guid? copyFromUserId,
Guid? teamId,
Guid? departmentId,
Guid? branchId,
string[] applicationKeys,
bool directLogon,
out List<string> permissions);
| Needed Permission | --- | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication with proposed logon and password information | |
| userName | Fore –and sure name of the user that shall be created | |
| copyFromUserId | NULL, if no defaults shall be copied or a valid user id, if the e.g. the worktime settings shall be copied. | |
| teamId | NULL, if the user shall not be added to an existing team – otherwise the Id of the existing team. | |
| departmentId | NULL, if the user shall not be added to an existing department – otherwise the Id of the existing department. | |
| branchId | NULL, if the user shall not be added to an existing branch – otherwise the Id of the existing branch. | |
| applicationKeys | The applications for that the user shall be created. | |
| directLogon | True, if the user shall be directly licensed. False, if the user shall only be created, but need not to be registered directly. | |
| Permissions | Out | List that contains the permissions of the newly created user. |
| return value | Object that contains the core user data and the permissions. |
DeleteUserProfileDataOlderThan
Mit Hilfe dieser Methode können Zeitdaten aus bestehenden Benutzerprofilen gelöscht werden. Hierzu wird der Delete Methode ein Zeitraum an Jahren mitgegeben. Zeitdaten, die älter sind als die angegebene Zahl an Jahren werden damit aus den übergebenen Profilen gelöscht.
void DeleteUserProfileDataOlderThan(
out TpFault fault,
TpAuthentication authentication,
int olderThanYears,
Guid[] userIds);
Hinweis: Es werden nur vollständig abgeschlossene Jahre berücksichtigt.
D.h. wenn im Mai 2018 Daten älter als 1 Jahr gelöscht werden sollen, so werden die Daten bis zum 31.12.2016 gelöscht.
| Needed Permission | dsgvo@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| olderThanYears | Specifies the amount of years to look back in time | |
| userIds | User ids for that the data shall be deleted. |
DownloadProfileImages
Diese Methode lädt die Profilbilder der angegebenen TimePunch Profile.
List<UserProfileImageDto> DownloadProfileImages(
out TpFault fault,
TpAuthentication authentication,
ImageFormat imageFormat,
Guid[] userIds);
| Needed Permission | core@logon (if server logon is with username) | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| imageFormat | The image format (e.g. max size) the user profiles shall be returned. Valid values are: Thumbnail16, Thumbnail24, Thumbnail32, Thumbnail64, Thumbnail128, Thumbnail256, Thumbnail512, Portrait300X400, Portrait512X682, Portrait600X800, Portrait768X1024, Portrait900X1200 | |
| Return value | List containing the profile images for the given profiles. |
ExportUserProfileData
Diese Methode exportiert die Profiledaten der gesuchten Mitarbeiter. Hierzu wird die Mitarbeitersuche verwendet.
List<UserProfileDataDto> ExportUserProfileData(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto search);
| Needed Permission | userProfiles@export | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| UserSearchDto | The search object that is used to find the profiles to export. | |
| Return value | List containing the profile data for the found profiles. |
ImportUserProfileData
Diese Methode importiert die Profildaten der übergebenen Mitarbeiter. Entscheidend für die Neuanlage oder Update des Profiles ist der Logon Name des Mitarbeiters.
List<UserProfileDataDto> ImportUserProfileData(
out TpFault fault,
TpAuthentication authentication,
List<UserProfileDataDto> userProfiles);
| Needed Permission | userProfiles@import | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userProfiles | List containing the profile data that shall be imported. | |
| Return value | List containing the profile data that has been imported. |
LoadUserProfileDefaults
Die Methode liefert die Vorgabewerte der angegebenen Mitarbeiterprofile zurück. Die Vorgabewerte dienen der internen Berechnungslogik (Gleitzeit / Urlaub) als Offset oder Basiswerte.
List<UserProfileDefaultsDto> LoadUserProfileDefaults(
out TpFault fault,
TpAuthentication authentication,
Guid[] userIds);
| Needed Permission | userProfiles@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userIds | The user ids of the members from which the profile defaults shall be loaded | |
| Return value | List with default profile information of the specified users. |
LoadUserProfileDetails
Diese Methode lädt die Detail Informationen zu dem Mitarbeiterprofil.
List<UserProfileDetailsDto> LoadUserProfileDetails(
out TpFault fault,
TpAuthentication authentication,
Guid[] userIds);
| Needed Permission | userProfiles@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userIds | The user ids of the members from which the profile details shall be loaded | |
| Return value | List with detailed profile information of the specified users. |
LoadUserProfileRights
Diese Methode lädt die Berechtigungen der angegebenen Mitarbeiterprofile.
List<UserProfileRightsDto> LoadUserProfileRights(
out TpFault fault,
TpAuthentication authentication,
Guid[] userIds);
| Needed Permission | permissions@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userIds | The user ids of the members from which the permissions shall be loaded | |
| Return value | List with profile permission information of the specified users. |
LoadUserProfileSensitive
Diese Methode lädt Datenschutz relevante und sensitive Mitarbeiterdaten von den übergebenen Mitarbeiterprofilen. Die Daten können nur von Benutzern mit entsprechender Berechtigung und auch nur dann ausgelesen werden, wenn die Mitarbeiter in der Coverage des Benutzers vorhanden sind.
List<UserProfileSensitiveDto> LoadUserProfileSensitive(
out TpFault fault,
TpAuthentication authentication,
Guid[] userIds)
| Needed Permission | userSensitive@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userIds | The user ids of the members from which the sensitive data shall be loaded | |
| Return value | List with sensitive information of the specified users. |
SaveUserProfileDefaults
Diese Methode aktualisiert die Vorgabewerte für die angegebenen Mitarbeiterprofile. Dies funktioniert jedoch nur, sofern für die Profile noch kein Monatsabschluss durchgeführt wurde. Um Basisdaten zu aktualisieren, muss die Methode SaveUserProfileDetails verwendet werden.
List<UserProfileDefaultsDto> SaveUserProfileDefaults(
out TpFault fault,
TpAuthentication authentication,
List<UserProfileDefaultsDto> defaults);
| Needed Permission | userProfiles@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| details | List containing the profile defaults that shall be updated. | |
| Return value | List containing the profile defaults that has been updated. |
SaveUserProfileDetails
Diese Methode aktualisiert die Profilinformationen für einen oder mehrere Mitarbeiter.
List<UserProfileDetailsDto> SaveUserProfileDetails(
out TpFault fault,
TpAuthentication authentication,
List<UserProfileDetailsDto> details);
| Needed Permission | userProfiles@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| details | List containing the profile data that shall be updated. | |
| Return value | List containing the profile data that has been updated. |
SaveUserProfileRights
Diese Methode aktualisiert die Rechte der angegebenen Mitarbeiterprofile. Um Basisdaten zu aktualisieren, muss die Methode SaveUserProfileDetails verwendet werden.
List<UserProfileRightsDto> SaveUserProfileRights(
out TpFault fault,
TpAuthentication authentication,
List<UserProfileRightsDto> rights);
| Needed Permission | permissions@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| details | List containing the profile rights that shall be updated. | |
| Return value | List containing the profile rights that has been updated. |
SaveUserProfileSensitive
Diese Methode speichert datenschutzrelevante Informationen der Mitarbeiter. Die Daten können nur von Benutzern mit entsprechender Berechtigung und auch nur dann gespeichert werden, wenn die Mitarbeiter in der Coverage des Benutzers vorhanden sind.
List<UserProfileSensitiveDto> SaveUserProfileSensitive(
out TpFault fault,
TpAuthentication authentication,
List<UserProfileSensitiveDto> sensitive);
| Needed Permission | userSensitive@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| sensitive | List containing the sensitive user data that shall be updated. | |
| Return value | List containing the profile rights that has been updated. |
SearchUserProfilesToDelete
Diese Methode sucht nach Benutzerprofilen, welche Daten enthalten, die Älter sind als die angegebene Zeit in Jahren. Die gefundenen Profile können als Grundlage für die Methode DeleteUserProfileDataOlderThan dienen.
List<UserDSGVOInfoDto> SearchUserProfilesToDelete(
out TpFault fault,
TpAuthentication authentication,
int olderThanYears,
UserSearchDto userSearchDto);
| Needed Permission | dsgvo@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| olderThanYears | Specifies the amount of years to look back in time | |
| userSearchDto | Search definition used to search the user profiles |
UploadProfileImage
Diese Methode aktualisiert die Profilbilder für die übergebenen Mitarbeiterprofile.
void UploadProfileImage(
out TpFault fault,
TpAuthentication authentication,
UserProfileImageDto[] profileImages);
| Needed Permission | userProfiles@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| profileImages | List containing the profile images that shall be updated. |